POST New Channel

Overview

---

The table below provides key details about the POST method to create a new channel.

Create New Channel
Method	POST
URL or Endpoint	/api/v1/projectId/channels
Headers	Authorization
Content Type	multipart/form-data
Parameters	projectId
Request Body	Title, Logo, Type, LatencyType, InputType, FilePath

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Before executing this API, please visit the other API for more information on the properties to achieve the desired response.

Request Body

The description of the body parameters is as follows:

Parameter Name	Mandatory	Type	Description
Title	Yes	string	Title of the channel
Logo	No	string($binary)	URL of channel's logo
Type	Yes	integer($int32)	Ingestion Type of RTMP(Real Time Messaging Protocol) Pull or Push
LatencyType	Yes	integer($int32)	Delay between event occurrence and viewer observation in live streaming
InputType	Yes	integer($int32)	Specifies the method which the live channel is delivered to the server
FilePath	No	string	Source URL from which the livestream is pulled from ingestion

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicId": "{channelId}",
    "streamId": "{streamId}",
    "name": "{streamName}",
    "title": "{channelTitle}",
    "logo": null,
    "streamServer": "rtmp://{streamServerLink]",
    "streamKey": "{streamKey}",
    "playbackUrl": "",
    "liveStatus": "Offline",
    "healthStatus": "Unknown",
    "inputSource": null
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
publicId	string	Returns the public identifier of the channel
streamId	string	Returns the unique identifier of the live job that handles the live streaming
name	string	Returns a guid that is randomly generated
title	string	Returns the title of the channel
logo	string($binary)	Returns the URL for the channel's logo
streamServer	string	Returns the RTMP URL of the streaming server where live video streams should be directed for ingestion
streamKey	string	Returns a unique identifier which is used to authenticate and identify a specific live stream on the streaming platform
playbackUrl	string	Returns a m3u8 file URL where the livestream can be accessed for playback
liveStatus	string	Indicate the live status of the channel
healthStatus	string	Indicate the health status of the channel
inputSource	string	Returns the location from which the live stream is being streamed
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed